Add an action and a GitHub workflow to get release notes via GitHub and prepare release content. #16

eason9487 · 2022-06-17T09:09:20Z

Changes proposed in this Pull Request:

This PR implements part 1 in #15 - 📌 Prepare a release content when a specific branch is created onto the target revision.

Move some functions to the utils directory.
Add generateReleaseNotes method to RepoTool class.
Add a new util getPackageSettings for getting the settings of package.json.
Add a new custom GitHub action for getting release notes via a GitHub API, and infer the next version and tag.
Add a new GitHub workflow to prepare a new release for the GitHub actions package.
Update docs for get-release-notes action and release process.

Before merge:

Delete release/actions-demo-1 and release/actions-demo-2 branches.
Clean up test branches if any.

Detailed test instructions:

Check simulations on Actions

💡 Since this workflow is not easy to test, I created two simulations to demonstrate the results. And two merged PRs (#11 and #12) were attached to the [actions] changelog: add label for grouping the changelog to match the version level.

The first one shows the initial release - workflow result
- For the first-time release, it won't bump the versions and will use the version value in package.json as the initial release version number.
- View the changes committed by the "Prepare New Release" workflow.
The second one simulates the version bumping and the second changelog prepending - workflow result
- For the subsequent release, it bumps the versions based on the version value in package.json, and increases the version level by matching the level keywords to the changelog content.
- In this demo, the content has a ### New Features 🎉 heading that matches the minor level. So the next version is 1.1.0.
- View the changes committed by the "Prepare New Release" workflow to check if the versions were updated.

Test the release preparation by creating the release branch

Create release/actions branch based on this PR. https://github.com/woocommerce/grow/tree/add/prepare-release-action
Go to the "Prepare New Release" workflow to see how it goes.

The release/actions-demo-1 and release/actions-demo-2 won't trigger the workflow. They were originally the release/actions branch, and I renamed them to keep the demo results.

Changelog entry

… API

tomalec · 2022-06-21T16:45:36Z

.github/workflows/github-actions-prepare-release.yml

+          TODAY=$(date '+%Y-%m-%d')
+          NEXT_VER="${{ steps.get-notes.outputs.next-version }}"
+          CHANGELOG="${{ steps.get-notes.outputs.release-changelog }}"
+          CHANGELOG=$(echo "$CHANGELOG" | sed -E 's/\.? by @[^ ]+ in (https:\/\/github\.com\/.+)/. (\1)/')


🚧 If we remove the PR authors and links, I think we should also remove the

## New Contributors

section. (See https://github.com/woorelease-bugs/initial-release/releases/new?tag=1.0.1 fro an example)

The outputs.release-changelog output only contains the part of "## What's Changed" heading and its entries. So other contents won't be included. I added output logs in the get-release-notes action by dd0226a. It should be easier to know the actual values of outputs and to use them.

Ah, ok, now I got it.
/## What's Changed\n([\d\D]+?)(?=\n\n)/i catches all the things before the double line break => before

##New Constributors

tomalec

Great tool, thanks!
Reviewed the code, and inspected workflow logs - LGTM.

The only comments I have are:

🚧 https://github.com/woocommerce/grow/pull/16/files#discussion_r902845866
💅 that maybe we don't need that much granularity between feature/update/enhancement and we can keep only two. But, I'm fine with all three as well to keep it consistent with bigger projects. Plus we could always change it later.

Address #16 (comment)

eason9487 · 2022-06-22T03:41:10Z

@tomalec, thanks for the review.

that maybe we don't need that much granularity between feature/update/enhancement and we can keep only two. But, I'm fine with all three as well to keep it consistent with bigger projects. Plus we could always change it later.

I adjusted the config of release notes in fc88a06. By the way, after some tests, the bot accounts like dependabot don't have the [bot] suffix when setting the exclude list in the config.

Could you help with a new round of code reviews?

tomalec

LGTM :) thanks

eason9487 added 8 commits June 15, 2022 20:26

Move repo-tool.js to utils directory

c481088

Move action error handler to utils

e22883c

Add generateReleaseNotes method to RepoTool class

0d0da16

Add a new util getPackageSettings

a0e1440

Add a new custom GitHub action for getting release notes via a GitHub…

a4b74c7

… API

Infer the next version and tag

b343099

Add a new workflow to prepare a new release for GitHub actions package

ec90f37

Update docs for get-release-notes action

6c4f1ac

eason9487 added the [actions] changelog: add label Jun 17, 2022

eason9487 requested a review from a team June 17, 2022 09:09

eason9487 self-assigned this Jun 17, 2022

tomalec reviewed Jun 21, 2022

View reviewed changes

eason9487 added 2 commits June 22, 2022 11:16

Add logs for output keys and values in the get-release-notes action

dd0226a

Tweak release notes config for the github-actions package.

fc88a06

Address #16 (comment)

eason9487 requested a review from tomalec June 22, 2022 03:41

tomalec approved these changes Jun 22, 2022

View reviewed changes

eason9487 merged commit bf7b9c1 into trunk Jun 23, 2022

eason9487 deleted the add/prepare-release-action branch June 23, 2022 02:15

eason9487 mentioned this pull request Jun 23, 2022

Release version 1.0.0 of the github-actions package #19

Merged

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Add an action and a GitHub workflow to get release notes via GitHub and prepare release content. #16

Add an action and a GitHub workflow to get release notes via GitHub and prepare release content. #16

eason9487 commented Jun 17, 2022 •

edited

Loading

tomalec Jun 21, 2022 •

edited

Loading

eason9487 Jun 22, 2022

tomalec Jun 22, 2022

tomalec left a comment

eason9487 commented Jun 22, 2022 •

edited

Loading

tomalec left a comment

Add an action and a GitHub workflow to get release notes via GitHub and prepare release content. #16

Add an action and a GitHub workflow to get release notes via GitHub and prepare release content. #16

Conversation

eason9487 commented Jun 17, 2022 • edited Loading

Changes proposed in this Pull Request:

Detailed test instructions:

Check simulations on Actions

Test the release preparation by creating the release branch

Changelog entry

tomalec Jun 21, 2022 • edited Loading

Choose a reason for hiding this comment

eason9487 Jun 22, 2022

Choose a reason for hiding this comment

tomalec Jun 22, 2022

Choose a reason for hiding this comment

tomalec left a comment

Choose a reason for hiding this comment

eason9487 commented Jun 22, 2022 • edited Loading

tomalec left a comment

Choose a reason for hiding this comment

eason9487 commented Jun 17, 2022 •

edited

Loading

tomalec Jun 21, 2022 •

edited

Loading

eason9487 commented Jun 22, 2022 •

edited

Loading